MarkLogic Server 11.0 Product Documentation
POST /manage/v2/groups/{id|name}

Summary

This resource address can be used to restart or shutdown a group in the cluster.

URL Parameters
format The format of the posted data. Can be either html, json, or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the request body. If the format? parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the request body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Location If the request causes a restart, a Location header is included in the reponse. The header contains a path with which to construct a URL to usable to test when the restart has completed.

Response

Upon success, MarkLogic Server returns status code 202 (Accepted). If the payload is malformed, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-admin role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage-admin

Usage Notes

The structure of the data in the request is as follows:

To restart a group:


    {"operation": "restart-group"}

To shutdown a group:


    {"operation": "shutdown-group"}

Example


curl -X POST --digest -u admin:admin -H "Content-type: application/json" \
-d '{"operation": "shutdown-group"}' http://localhost:8002/manage/v2/groups/Foo 

==>  Shuts down the "Foo" group in the cluster.
Powered by MarkLogic Server | Terms of Use | Privacy Policy